@nuucognition/ncm-ui 0.1.0-dev.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 NUU Cognition
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,129 @@
+# @nuucognition/ncm-ui
+
+React renderers for [NUU Cognition Markdown](https://www.npmjs.com/package/@nuucognition/ncm) (NCM) blocks.
+
+`@nuucognition/ncm` turns markdown into a tree of semantic **Blocks**;
+`@nuucognition/ncm-ui` renders those Blocks to accessible, themeable React
+markup. Every block type ships a default renderer, each renderer can be
+overridden, and every block is wrapped in a local error boundary so a single bad
+block never takes down the document.
+
+## Installation
+
+```bash
+pnpm add @nuucognition/ncm @nuucognition/ncm-ui react react-dom
+```
+
+`react` and `react-dom` (`^18` or `^19`) are **peer dependencies** — they come
+from your app. `@nuucognition/ncm` is a required runtime dependency (you parse
+with it, then render). KaTeX and Shiki are bundled and lazy-loaded.
+
+The package emits ESM JavaScript and `.d.ts` files to `dist`, keeps CSS files as
+side effects, and preserves `"use client"` banners for React Server Component
+consumers.
+
+## Usage
+
+```tsx
+import { parseNcm } from "@nuucognition/ncm"
+import { NcmDocument } from "@nuucognition/ncm-ui"
+import "@nuucognition/ncm-ui/styles/nuu.css"
+
+const doc = parseNcm(markdown)
+
+export function Article() {
+  return <NcmDocument blocks={doc.blocks ?? []} />
+}
+```
+
+Custom renderers can override any block type:
+
+```tsx
+<NcmDocument
+  blocks={blocks}
+  renderers={{
+    mermaid: MermaidRenderer,
+  }}
+/>
+```
+
+Each block is wrapped in a local error boundary. A throwing renderer falls back
+to the escaped-source fallback for that block, while sibling blocks continue to
+render. Unknown block types use the same fallback and emit a warning.
+
+## Styles
+
+The package ships two prebuilt stylesheets plus the fonts they reference. Import
+whichever theme you want (or neither, if you supply your own):
+
+```tsx
+import "@nuucognition/ncm-ui/styles/nuu.css"    // default NUU theme
+import "@nuucognition/ncm-ui/styles/paper.css"  // editorial "paper" theme
+```
+
+Both are listed under `sideEffects` so bundlers keep them when tree-shaking.
+
+## Subpath Exports
+
+The root entry re-exports the common surface. Granular subpaths are available
+for consumers who want to import a single renderer or utility without pulling in
+the rest:
+
+| Subpath | Contents |
+|---|---|
+| `.` | `NcmDocument`, `NcmBlock`, default renderers, providers, tokens |
+| `./components/*` | `BlockShell`, `NcmBlock`, `NcmDocument`, and helpers |
+| `./blocks/*` | Individual block renderers (e.g. `./blocks/table`, `./blocks/code`) |
+| `./inline` | Inline token renderers |
+| `./context` | `NcmProvider`, `NcmReferencesProvider`, config/reference hooks |
+| `./hooks/*` | Standalone hooks |
+| `./lib/*` | Rendering utilities |
+| `./types` | Renderer registry and prop types |
+| `./styles/nuu.css`, `./styles/paper.css` | Prebuilt themes |
+
+## HTML Rendering
+
+`HtmlBlock` is the default renderer for `html` blocks. It renders HTML source as escaped text.
+
+Consumers that intentionally support HTML can opt into sanitized injection:
+
+```tsx
+import { NcmDocument, SanitizedHtmlBlock } from "@nuucognition/ncm-ui"
+
+<NcmDocument
+  blocks={blocks}
+  renderers={{
+    html: SanitizedHtmlBlock,
+  }}
+/>
+```
+
+`SanitizedHtmlBlock` runs `@nuucognition/ncm`'s HTML sanitizer before injecting
+markup. Keep `HtmlBlock` as the default for untrusted documents. Use
+`SanitizedHtmlBlock` only when the surface intentionally supports HTML.
+
+## Math And Code Rendering
+
+KaTeX is lazy-loaded and memoized, so documents without math do not pay the
+KaTeX render cost. Shiki syntax highlighting also loads on demand. The tests
+assert the wrapper attributes around KaTeX output rather than snapshotting the
+full KaTeX markup.
+
+## Verification
+
+```bash
+pnpm --filter @nuucognition/ncm-ui lint
+pnpm --filter @nuucognition/ncm-ui typecheck
+pnpm --filter @nuucognition/ncm-ui build
+pnpm --filter @nuucognition/ncm-ui test
+```
+
+The root NCM gate runs both `@nuucognition/ncm-tests` and `@nuucognition/ncm-ui`:
+
+```bash
+pnpm test
+```
+
+## License
+
+MIT

package/dist/blocks/admonition/index.d.ts

@@ -0,0 +1,13 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { AdmonitionBlock as AdmonitionBlock$1 } from '@nuucognition/ncm';
+import { a as BlockRendererProps } from '../../renderers-C5f41FCy.js';
+import 'react';
+
+type AdmonitionBlockProps = BlockRendererProps<AdmonitionBlock$1>;
+/**
+ * Admonition (callout) renderer. Collapsible admonitions render as `<details>`;
+ * static ones as a titled region. Child blocks render through `NcmBlock`.
+ */
+declare function AdmonitionBlock({ block, className }: AdmonitionBlockProps): react_jsx_runtime.JSX.Element;
+
+export { AdmonitionBlock, type AdmonitionBlockProps };